Get settings - who can send messages
Check if only admins can send messages to the group.
Authentication Required
Login to swap the placeholders with your real Instance ID and Access Token.
Log InNo query parameters required
This endpoint doesn't expect data in the URL.
Best practices
Use this to determine if your bot can reply in a group where it is not admin.
Display a 'Read Only' UI to agents if this is set to true.
Conversational Auditing: The Strategic Control of Global Dialogue
In the orchestration of high-volume community networks, the ability to control the "Microphone" is as important as the ability to send the message. The Get Messages Admin Only endpoint is your primary tool for Strategic Conversational Auditing and Signal-to-Noise Verification. It allows your automated systems to programmatically query whether a group is currently in "Announcement Mode" (Admins only) or "Collaboration Mode" (All participants). By retrieving this boolean state, your platform can make intelligent decisions about its messaging strategy, its moderation load, and its overall posture within the group, ensuring that your organization's voice is always synchronized with the structural permissions of the channel.
For enterprise architects, this endpoint is the Pulse Check of Channel Discipline. This guide explores the strategic imperatives of interaction auditing and the guardianship of community focus.
🏗️ Architectural Philosophy: Retrieving the Presence of the Interaction Mask
From a technical perspective, the Get Messages Admin Only endpoint is a Low-Latency Permissions Snapshot.
Key Architectural Objectives:
- The Foundation of Channel Readiness: Before initiating a high-priority broadcast, your system needs to know if the channel is "Clear." By retrieving the current message security state, your system can verify that the group is locked to admins-only before sending a critical alert. This ensures that your alert is the first thing a user sees, rather than being buried in a flurry of participant replies.
- Permissionless Monitoring: Any instance that is a member of the group can query its security settings via this API. This allows you to build a "Monitoring Grid"—where a network of instances tracks the conversation state across hundreds of groups—without requiring administrative rights in every single one.
- Real-Time State Mapping: Webhooks tell you when a change happens, but the GET API tells you what the state is. During system re-initialization or after a period of instability, this call provides the authoritative "Ground Truth" for your internal state machines.
🚀 Strategic Use Case: Automated Channel Readiness and Alert Verification
Understanding the "Microphone State" is the first step in sophisticated campaign orchestration.
1. The "Clean Channel" Pre-Flight Check
Imagine an automated emergency notification system. Before sending an evacuate-and-report order to 1,000 field staff, the system calls the Get Messages Admin Only endpoint. If it finds the group is currently unlocked, it first calls the Set Messages Admin Only endpoint to "Clear the Floor," and then finally sends the alert. This sequence ensures that the communication is professional, focused, and un-interruptible.
2. Forensic Auditing for "Quiet Hours" Enforcement
Many corporate communities have a "No-Noise" policy after hours. Your system can use this endpoint to audit its portfolio at 5:00 PM. If a group is still in Collaborative Mode, the system can automatically flag it for moderation. By verifying the state rather than just assuming it, you ensure that your global "Quiet Hours" policy is being structuraly enforced by the API, rather than relying on human memory.
3. Dynamic Workflow Branching
Your bot's behavior should change based on whether the group is locked. If your bot is a "Question-and-Answer" assistant, its logic can use this endpoint to determine its own availability. If the group is locked to admins, the bot can send a message: "The floor is currently closed for official announcements. I will be available for questions once the admins reopen the chat." This provides a premium, context-aware user experience that reflects the actual technical state of the room.
🔐 Administrative Mandate: The Guardianship of Community Focus
In a professional environment, noise is a cost. Auditing the "Microphone" is a method of cost-control.
Integrity in High-Stakes Broadcasting
For PR and Marketing teams, the ability to confirm that a "Listen-Only" environment is active is essential for campaign success. This endpoint provides the raw data for your "Campaign Governance Report," proving that for the duration of a specific product launch, the community was maintained as a high-fidelity broadcast channel with no external interference.
Protecting the User Experience
Users join Groups (vs. Communities) often expecting a high-signal environment. If a group stays in "Chatty" mode too long, attrition (leaving) increases. By programmatically auditing the message settings, your system acts as the "Experience Guardian"—ensuring that the group returns to a focused, announcement-driven state once a collaborative session has concluded.
🛡️ Operational Best Practices: Consistency and Demographic Sensitivity
- The "Initialization Sync" Pattern: Always call this endpoint immediately after a successful Join or Create. Understand the structural boundaries of your new home before you start speaking.
- Automated Status Dashboards: Display the "Microphone State" (
LockedorOpen) clearly in your agent's UI. It is one of the most important pieces of metadata for an agent tasked with managing hundreds of active conversations. - Coordinate with Throttling Logic: If the group is in "Open" mode, your system should prepare for a higher volume of incoming webhooks. Use the result of this GET call to dynamically scale your webhook processing workers for that specific instance.
⚙️ Engineering Best Practices: The Validation Loop
- State-Driven Logic Branching: Build your bot's command-parsing logic to be "Governance Aware." If the group is in admin-only mode, the bot should only respond to commands from admins, even if its internal logic usually allows regular users to interact.
- Handle Network Propagation: When changing the setting via the Set API, allow for a short network propagation delay (approx. 500ms) before re-verifying the state via the GET API to ensure your local cache reflects the server-side change.
- Cross-Reference with Admin Authority: Knowing the group is locked is only useful if you know who can speak. Combine the data from this endpoint with the Get Participants API to build a complete map of authoritative voices in the room.
🎯 Conclusion: Mastering the Art of the Focused Community
The Get Messages Admin Only endpoint is the "Stethoscope" of your community architecture. It is your most powerful tool for monitoring channel discipline, enforcing focus, and ensuring that your organization's voice is always delivered in the optimal structural environment. By treating the "Microphone State" as a critical piece of operational intelligence to be audited and verified, you build a conversational ecosystem that is professional, respectful of its users' attention, and always aligned with your strategic goals. You move beyond "Simple Messaging" and into the world of Structured Dialogue Orchestration, where every silence is verified and every broadcast is protected by the structural integrity of the network.
Request Parameters
Configure the parameters required to interact with this endpoint. All query and body arguments are listed below with their details.
URL Parameters
Passed in the URL query stringstring | Your unique WhatsApp Instance ID Example: | ||
string | Your API Access Token Example: | ||
string | The unique ID of the group Example: |
Request Samples
Use these ready-to-go code snippets to integrate our API into your project quickly and efficiently. Choose your preferred language and library.
Expected Responses
Explore all possible responses and outcomes from the server. We have documented each status code with data examples to make success and error handling easier.
Example
{
"adminOnly": false
}Command Palette
Search for a command to run...